home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / util / gnu / apatch20.lha / patch-2.0.12u8 / patch.doc < prev    next >
Text File  |  1992-09-17  |  18KB  |  523 lines
  1. LOCAL                                                    PATCH(1)
  2.  
  3.  
  4.  
  5. NAME
  6.      patch - apply a diff file to an original
  7.  
  8. SYNOPSIS
  9.      patch [options] [origfile [patchfile]] [+ [options] [orig-
  10.      file]]...
  11.  
  12.      but usually just
  13.  
  14.      patch <patchfile
  15.  
  16. DESCRIPTION
  17.      Patch will take a patch file containing any of the four
  18.      forms of difference listing produced by the diff program and
  19.      apply those differences to an original file, producing a
  20.      patched version.  By default, the patched version is put in
  21.      place of the original, with the original file backed up to
  22.      the same name with the extension ".orig" ("~" on systems
  23.      that do not support long filenames), or as specified by the
  24.      -b, -B, or -V switches.  The extension used for making
  25.      backup files may also be specified in the
  26.      SIMPLE_BACKUP_SUFFIX environment variable, which is overrid-
  27.      den by above switches.
  28.  
  29.      If the backup file already exists, patch creates a new
  30.      backup file name by changing the first lowercase letter in
  31.      the last component of the file's name into uppercase.  If
  32.      there are no more lowercase letters in the name, it removes
  33.      the first character from the name.  It repeats this process
  34.      until it comes up with a backup file that does not already
  35.      exist.
  36.  
  37.      You may also specify where you want the output to go with a
  38.      -o switch; if that file already exists, it is backed up
  39.      first.
  40.  
  41.      If patchfile is omitted, or is a hyphen, the patch will be
  42.      read from standard input.
  43.  
  44.      Upon startup, patch will attempt to determine the type of
  45.      the diff listing, unless over-ruled by a -c, -e, -n, or -u
  46.      switch.  Context diffs (old-style, new-style, and unified)
  47.      and normal diffs are applied by the patch program itself,
  48.      while ed diffs are simply fed to the ed editor via a pipe.
  49.  
  50.      Patch will try to skip any leading garbage, apply the diff,
  51.      and then skip any trailing garbage.  Thus you could feed an
  52.      article or message containing a diff listing to patch, and
  53.      it should work.  If the entire diff is indented by a con-
  54.      sistent amount, this will be taken into account.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                                                 1
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67. PATCH(1)                                                    LOCAL
  68.  
  69.  
  70.  
  71.      With context diffs, and to a lesser extent with normal
  72.      diffs, patch can detect when the line numbers mentioned in
  73.      the patch are incorrect, and will attempt to find the
  74.      correct place to apply each hunk of the patch.  As a first
  75.      guess, it takes the line number mentioned for the hunk, plus
  76.      or minus any offset used in applying the previous hunk.  If
  77.      that is not the correct place, patch will scan both forwards
  78.      and backwards for a set of lines matching the context given
  79.      in the hunk.  First patch looks for a place where all lines
  80.      of the context match.  If no such place is found, and it's a
  81.      context diff, and the maximum fuzz factor is set to 1 or
  82.      more, then another scan takes place ignoring the first and
  83.      last line of context.  If that fails, and the maximum fuzz
  84.      factor is set to 2 or more, the first two and last two lines
  85.      of context are ignored, and another scan is made.  (The
  86.      default maximum fuzz factor is 2.) If patch cannot find a
  87.      place to install that hunk of the patch, it will put the
  88.      hunk out to a reject file, which normally is the name of the
  89.      output file plus ".rej" ("#" on systems that do not support
  90.      long filenames).  (Note that the rejected hunk will come out
  91.      in context diff form whether the input patch was a context
  92.      diff or a normal diff.  If the input was a normal diff, many
  93.      of the contexts will simply be null.) The line numbers on
  94.      the hunks in the reject file may be different than in the
  95.      patch file: they reflect the approximate location patch
  96.      thinks the failed hunks belong in the new file rather than
  97.      the old one.
  98.  
  99.      As each hunk is completed, you will be told whether the hunk
  100.      succeeded or failed, and which line (in the new file) patch
  101.      thought the hunk should go on.  If this is different from
  102.      the line number specified in the diff you will be told the
  103.      offset.  A single large offset MAY be an indication that a
  104.      hunk was installed in the wrong place.  You will also be
  105.      told if a fuzz factor was used to make the match, in which
  106.      case you should also be slightly suspicious.
  107.  
  108.      If no original file is specified on the command line, patch
  109.      will try to figure out from the leading garbage what the
  110.      name of the file to edit is.  In the header of a context
  111.      diff, the filename is found from lines beginning with "***"
  112.      or "---", with the shortest name of an existing file win-
  113.      ning.  Only context diffs have lines like that, but if there
  114.      is an "Index:" line in the leading garbage, patch will try
  115.      to use the filename from that line.  The context diff header
  116.      takes precedence over an Index line.  If no filename can be
  117.      intuited from the leading garbage, you will be asked for the
  118.      name of the file to patch.
  119.  
  120.      If the original file cannot be found or is read-only, but a
  121.      suitable SCCS or RCS file is handy, patch will attempt to
  122.      get or check out the file.
  123.  
  124.  
  125.  
  126. 2
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133. LOCAL                                                    PATCH(1)
  134.  
  135.  
  136.  
  137.      Additionally, if the leading garbage contains a "Prereq: "
  138.      line, patch will take the first word from the prerequisites
  139.      line (normally a version number) and check the input file to
  140.      see if that word can be found.  If not, patch will ask for
  141.      confirmation before proceeding.
  142.  
  143.      The upshot of all this is that you should be able to say,
  144.      while in a news interface, the following:
  145.  
  146.           | patch -d /usr/src/local/blurfl
  147.  
  148.      and patch a file in the blurfl directory directly from the
  149.      article containing the patch.
  150.  
  151.      If the patch file contains more than one patch, patch will
  152.      try to apply each of them as if they came from separate
  153.      patch files.  This means, among other things, that it is
  154.      assumed that the name of the file to patch must be deter-
  155.      mined for each diff listing, and that the garbage before
  156.      each diff listing will be examined for interesting things
  157.      such as filenames and revision level, as mentioned previ-
  158.      ously.  You can give switches (and another original file
  159.      name) for the second and subsequent patches by separating
  160.      the corresponding argument lists by a '+'.  (The argument
  161.      list for a second or subsequent patch may not specify a new
  162.      patch file, however.)
  163.  
  164.      Patch recognizes the following switches:
  165.  
  166.      -b   causes the next argument to be interpreted as the
  167.           backup extension, to be used in place of ".orig" or
  168.           "~".
  169.  
  170.      -B   causes the next argument to be interpreted as a prefix
  171.           to the backup file name. If this argument is specified
  172.           any argument from -b will be ignored.
  173.  
  174.      -c   forces patch to interpret the patch file as a context
  175.           diff.
  176.  
  177.      -d   causes patch to interpret the next argument as a direc-
  178.           tory, and cd to it before doing anything else.
  179.  
  180.      -D   causes patch to use the "#ifdef...#endif" construct to
  181.           mark changes.  The argument following will be used as
  182.           the differentiating symbol.  Note that, unlike the C
  183.           compiler, there must be a space between the -D and the
  184.           argument.
  185.  
  186.      -e   forces patch to interpret the patch file as an ed
  187.           script.
  188.  
  189.  
  190.  
  191.  
  192.                                                                 3
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199. PATCH(1)                                                    LOCAL
  200.  
  201.  
  202.  
  203.      -E   causes patch to remove output files that are empty
  204.           after the patches have been applied.
  205.  
  206.      -f   forces patch to assume that the user knows exactly what
  207.           he or she is doing, and to not ask any questions.  It
  208.           assumes the following: skip patches for which a file to
  209.           patch can't be found; patch files even though they have
  210.           the wrong version for the ``Prereq:'' line in the
  211.           patch; and assume that patches are not reversed even if
  212.           they look like they are.  This option does not suppress
  213.           commentary; use -s for that.
  214.  
  215.      -t   similar to -f, in that it suppresses questions, but
  216.           makes some different assumptions: skip patches for
  217.           which a file to patch can't be found (the same as -f);
  218.           skip patches for which the file has the wrong version
  219.           for the ``Prereq:'' line in the patch; and assume that
  220.           patches are reversed if they look like they are.
  221.  
  222.      -F<number>
  223.           sets the maximum fuzz factor.  This switch only applies
  224.           to context diffs, and causes patch to ignore up to that
  225.           many lines in looking for places to install a hunk.
  226.           Note that a larger fuzz factor increases the odds of a
  227.           faulty patch.  The default fuzz factor is 2, and it may
  228.           not be set to more than the number of lines of context
  229.           in the context diff, ordinarily 3.
  230.  
  231.      -l   causes the pattern matching to be done loosely, in case
  232.           the tabs and spaces have been munged in your input
  233.           file.  Any sequence of whitespace in the pattern line
  234.           will match any sequence in the input file.  Normal
  235.           characters must still match exactly.  Each line of the
  236.           context must still match a line in the input file.
  237.  
  238.      -n   forces patch to interpret the patch file as a normal
  239.           diff.
  240.  
  241.      -N   causes patch to ignore patches that it thinks are
  242.           reversed or already applied.  See also -R .
  243.  
  244.      -o   causes the next argument to be interpreted as the out-
  245.           put file name.
  246.  
  247.      -p<number>
  248.           sets the pathname strip count, which controls how path-
  249.           names found in the patch file are treated, in case the
  250.           you keep your files in a different directory than the
  251.           person who sent out the patch.  The strip count speci-
  252.           fies how many slashes are to be stripped from the front
  253.           of the pathname.  (Any intervening directory names also
  254.           go away.) For example, supposing the filename in the
  255.  
  256.  
  257.  
  258. 4
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265. LOCAL                                                    PATCH(1)
  266.  
  267.  
  268.  
  269.           patch file was
  270.  
  271.                /u/howard/src/blurfl/blurfl.c
  272.  
  273.           setting -p or -p0 gives the entire pathname unmodified,
  274.           -p1 gives
  275.  
  276.                u/howard/src/blurfl/blurfl.c
  277.  
  278.           without the leading slash, -p4 gives
  279.  
  280.                blurfl/blurfl.c
  281.  
  282.           and not specifying -p at all just gives you "blurfl.c",
  283.           unless all of the directories in the leading path
  284.           (u/howard/src/blurfl) exist and that path is relative,
  285.           in which case you get the entire pathname unmodified.
  286.           Whatever you end up with is looked for either in the
  287.           current directory, or the directory specified by the -d
  288.           switch.
  289.  
  290.      -r   causes the next argument to be interpreted as the
  291.           reject file name.
  292.  
  293.      -R   tells patch that this patch was created with the old
  294.           and new files swapped.  (Yes, I'm afraid that does hap-
  295.           pen occasionally, human nature being what it is.) Patch
  296.           will attempt to swap each hunk around before applying
  297.           it.  Rejects will come out in the swapped format.  The
  298.           -R switch will not work with ed diff scripts because
  299.           there is too little information to reconstruct the
  300.           reverse operation.
  301.  
  302.           If the first hunk of a patch fails, patch will reverse
  303.           the hunk to see if it can be applied that way.  If it
  304.           can, you will be asked if you want to have the -R
  305.           switch set.  If it can't, the patch will continue to be
  306.           applied normally.  (Note: this method cannot detect a
  307.           reversed patch if it is a normal diff and if the first
  308.           command is an append (i.e. it should have been a
  309.           delete) since appends always succeed, due to the fact
  310.           that a null context will match anywhere.  Luckily, most
  311.           patches add or change lines rather than delete them, so
  312.           most reversed normal diffs will begin with a delete,
  313.           which will fail, triggering the heuristic.)
  314.  
  315.      -s   makes patch do its work silently, unless an error
  316.           occurs.
  317.  
  318.      -S   causes patch to ignore this patch from the patch file,
  319.           but continue on looking for the next patch in the file.
  320.           Thus
  321.  
  322.  
  323.  
  324.                                                                 5
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331. PATCH(1)                                                    LOCAL
  332.  
  333.  
  334.  
  335.                patch -S + -S + <patchfile
  336.  
  337.           will ignore the first and second of three patches.
  338.  
  339.      -u   forces patch to interpret the patch file as a unified
  340.           context diff (a unidiff).
  341.  
  342.      -v   causes patch to print out its revision header and patch
  343.           level.
  344.  
  345.      -V   causes the next argument to be interpreted as a method
  346.           for creating backup file names.  The type of backups
  347.           made can also be given in the VERSION_CONTROL environ-
  348.           ment variable, which is overridden by this option.  The
  349.           -B option overrides this option, causing the prefix to
  350.           always be used for making backup file names.  The value
  351.           of the VERSION_CONTROL environment variable and the
  352.           argument to the -V option are like the GNU Emacs
  353.           `version-control' variable; they also recognize
  354.           synonyms that are more descriptive.  The valid values
  355.           are (unique abbreviations are accepted):
  356.  
  357.           `t' or `numbered'
  358.             Always make numbered backups.
  359.  
  360.           `nil' or `existing'
  361.             Make numbered backups of files that already have
  362.             them, simple backups of the others.  This is the
  363.             default.
  364.  
  365.           `never' or `simple'
  366.             Always make simple backups.
  367.  
  368.      -x<number>
  369.           sets internal debugging flags, and is of interest only
  370.           to patch patchers.
  371.  
  372. AUTHOR
  373.      Larry Wall <lwall@netlabs.com>
  374.      with many other contributors.
  375.  
  376. ENVIRONMENT
  377.      TMPDIR
  378.           Directory to put temporary files in; default is /tmp.
  379.  
  380.      SIMPLE_BACKUP_SUFFIX
  381.           Extension to use for backup file names instead of
  382.           ".orig" or "~".
  383.  
  384.      VERSION_CONTROL
  385.           Selects when numbered backup files are made.
  386.  
  387.  
  388.  
  389.  
  390. 6
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397. LOCAL                                                    PATCH(1)
  398.  
  399.  
  400.  
  401. FILES
  402.      $TMPDIR/patch*
  403.  
  404. SEE ALSO
  405.      diff(1)
  406.  
  407. NOTES FOR PATCH SENDERS
  408.      There are several things you should bear in mind if you are
  409.      going to be sending out patches.  First, you can save people
  410.      a lot of grief by keeping a patchlevel.h file which is
  411.      patched to increment the patch level as the first diff in
  412.      the patch file you send out.  If you put a Prereq: line in
  413.      with the patch, it won't let them apply patches out of order
  414.      without some warning.  Second, make sure you've specified
  415.      the filenames right, either in a context diff header, or
  416.      with an Index: line.  If you are patching something in a
  417.      subdirectory, be sure to tell the patch user to specify a -p
  418.      switch as needed.  Third, you can create a file by sending
  419.      out a diff that compares a null file to the file you want to
  420.      create.  This will only work if the file you want to create
  421.      doesn't exist already in the target directory.  Fourth, take
  422.      care not to send out reversed patches, since it makes people
  423.      wonder whether they already applied the patch.  Fifth, while
  424.      you may be able to get away with putting 582 diff listings
  425.      into one file, it is probably wiser to group related patches
  426.      into separate files in case something goes haywire.
  427.  
  428. DIAGNOSTICS
  429.      Too many to list here, but generally indicative that patch
  430.      couldn't parse your patch file.
  431.  
  432.      The message "Hmm..." indicates that there is unprocessed
  433.      text in the patch file and that patch is attempting to
  434.      intuit whether there is a patch in that text and, if so,
  435.      what kind of patch it is.
  436.  
  437.      Patch will exit with a non-zero status if any reject files
  438.      were created.  When applying a set of patches in a loop it
  439.      behooves you to check this exit status so you don't apply a
  440.      later patch to a partially patched file.
  441.  
  442. CAVEATS
  443.      Patch cannot tell if the line numbers are off in an ed
  444.      script, and can only detect bad line numbers in a normal
  445.      diff when it finds a "change" or a "delete" command.  A con-
  446.      text diff using fuzz factor 3 may have the same problem.
  447.      Until a suitable interactive interface is added, you should
  448.      probably do a context diff in these cases to see if the
  449.      changes made sense.  Of course, compiling without errors is
  450.      a pretty good indication that the patch worked, but not
  451.      always.
  452.  
  453.  
  454.  
  455.  
  456.                                                                 7
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463. PATCH(1)                                                    LOCAL
  464.  
  465.  
  466.  
  467.      Patch usually produces the correct results, even when it has
  468.      to do a lot of guessing.  However, the results are
  469.      guaranteed to be correct only when the patch is applied to
  470.      exactly the same version of the file that the patch was gen-
  471.      erated from.
  472.  
  473. BUGS
  474.      Could be smarter about partial matches, excessively deviant
  475.      offsets and swapped code, but that would take an extra pass.
  476.  
  477.      If code has been duplicated (for instance with #ifdef OLD-
  478.      CODE ... #else ...  #endif), patch is incapable of patching
  479.      both versions, and, if it works at all, will likely patch
  480.      the wrong one, and tell you that it succeeded to boot.
  481.  
  482.      If you apply a patch you've already applied, patch will
  483.      think it is a reversed patch, and offer to un-apply the
  484.      patch.  This could be construed as a feature.
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522. 8
  523.